home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1997 May / macformat-050.iso / Shareware Plus / Developers / Find_icon folder / Headers / Get_custom_folder_icon.h < prev    next >
Encoding:
C/C++ Source or Header  |  1997-01-25  |  1.7 KB  |  55 lines  |  [TEXT/CWIE]
  1. /*    ---------------------------------------------------------------------------------------------
  2.     Find_icon, code for constructing icon suites for files and folders
  3.     
  4.     by James W. Walker
  5.     preferred e-mail: <mailto:jwwalker@kagi.com>
  6.     alternate e-mail: <mailto:jwwalker@aol.com>, <jim@nisus-soft.com>
  7.     web: <http://users.aol.com/jwwalker/>
  8.     
  9.     File: Get_custom_folder_icon.h
  10.     
  11.     Copyright ©1997 by James W. Walker
  12.     
  13.     You may incorporate this sample code into your applications without
  14.     restriction, though the sample code has been provided "AS IS" and the
  15.     responsibility for its operation is 100% yours.
  16.     If you're going to re-distribute the source, please make it clear
  17.     that the code was descended from James W. Walker's code,
  18.     but that you've made changes.
  19.     ---------------------------------------------------------------------------------------------
  20. */
  21.  
  22. #ifndef __TYPES__
  23.     #include <Types.h>
  24. #endif
  25.  
  26. #ifndef __FILES__
  27.     #include <Files.h>
  28. #endif
  29.  
  30. #ifndef    _H_MetaSelector_
  31.     #include "MetaSelector.h"
  32. #endif
  33.  
  34. OSErr    Get_custom_folder_icon(
  35. /* --> */    short                vRefNum,
  36. /* --> */    long                dirID,
  37. /* --> */    MetaSelectorValue    icon_selector,
  38. /* <-- */    Handle                *the_suite
  39. );
  40. /*    ¶ Create an icon suite for a folder that is known to have a
  41.     custom icon.
  42.     The icons in the suite are not resources, and it is your
  43.     responsibility to dispose of the suite when you are done with it.
  44.     
  45.     vRefNum            input:    volume specification
  46.     dirID            input:    directory ID number
  47.     icon_selector    input:    an icon type mask, as defined in <Icons.h>.
  48.                             You can also use the special masks in MetaSelector.h,
  49.                             for instance svLargeThenSmall means to first
  50.                             search for large icons, but if none are found,
  51.                             try for small icons.
  52.     the_suite        output:    The new icon suite.
  53.     
  54. */
  55.